Skip to content

Comments

feat: add optional avatar column to contributors table#388

Merged
jmeridth merged 3 commits intogithub-community-projects:mainfrom
vchrombie:feat/show-avatars-markdown-table-23
Feb 24, 2026
Merged

feat: add optional avatar column to contributors table#388
jmeridth merged 3 commits intogithub-community-projects:mainfrom
vchrombie:feat/show-avatars-markdown-table-23

Conversation

@vchrombie
Copy link
Contributor

@vchrombie vchrombie commented Jan 25, 2026

Fixes #23

Add SHOW_AVATAR flag plumbing from env to markdown output so avatars render as a column when enabled, update README and tests accordingly.

Pull Request

Proposed Changes

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

  • Label as either bug, documentation, enhancement, infrastructure, maintenance or breaking

@vchrombie vchrombie requested a review from a team as a code owner January 25, 2026 21:04
Copilot AI review requested due to automatic review settings January 25, 2026 21:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds an optional SHOW_AVATAR environment variable that allows users to display contributor profile pictures in the markdown output table. The feature addresses issue #23 by utilizing the avatar_url field that was already being stored.

Changes:

  • Added SHOW_AVATAR environment variable with default value of False
  • Added avatar column as the first column in the contributor table when enabled
  • Added _is_truthy() helper function to handle boolean conversion from string and bool types
  • Updated tests to cover the new avatar functionality and updated existing tests to handle the new parameter

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
env.py Added SHOW_AVATAR environment variable handling via get_bool_env_var() and updated return type signature
contributors.py Added show_avatar parameter to the flow, passing it from env to markdown output
markdown.py Added _is_truthy() helper, added show_avatar parameter to functions, implemented avatar column with HTML img tags
test_env.py Updated all test cases to include SHOW_AVATAR environment variable and verified it returns False when set to "False"
test_markdown.py Added comprehensive test for avatar functionality with proper expected output validation
README.md Documented the new SHOW_AVATAR configuration option with usage examples

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

@vchrombie vchrombie force-pushed the feat/show-avatars-markdown-table-23 branch from b57096b to 8ec1034 Compare February 4, 2026 04:02
@vchrombie
Copy link
Contributor Author

I believe there some lint errors in README.md, I fixed them.

@vchrombie vchrombie force-pushed the feat/show-avatars-markdown-table-23 branch from 8ec1034 to 92419ac Compare February 11, 2026 02:59
@zkoppert
Copy link
Collaborator

@vchrombie Want to work on this branch next? The other one is all merged.

Also, FYI: We transferred the repository from the github org to the github-community-projects org to enable us to add maintainers that don't work at GitHub. Be sure to update your git remote urls to the new org.

@vchrombie vchrombie force-pushed the feat/show-avatars-markdown-table-23 branch 4 times, most recently from 8bdb6e4 to 0f37ab1 Compare February 24, 2026 05:15
Add SHOW_AVATAR flag plumbing from env to markdown output so avatars
render as a column when enabled, update README and tests accordingly.

Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>
@vchrombie vchrombie force-pushed the feat/show-avatars-markdown-table-23 branch from 0f37ab1 to 8e8e6dc Compare February 24, 2026 05:19
Copy link
Collaborator

@jmeridth jmeridth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Nice helper functions for output filename and checking truthy. Thank you for your contribution.

@jmeridth jmeridth merged commit e5629ec into github-community-projects:main Feb 24, 2026
6 checks passed
@vchrombie vchrombie deleted the feat/show-avatars-markdown-table-23 branch February 24, 2026 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature: Add option to show profile picture in the markdown output contributor table

3 participants